/*-
 * SRQ.java          TP-Status-Report-Qualifier (TP-SRQ)
 * 
 * $LastChangedBy: stein $
 * $LastChangedRevision: 98 $
 * $LastChangedDate: 2007-02-20 15:18:26 +0000 (Tue, 20 Feb 2007) $
 * $HeadURL: svn://localhost/SMS/src/com/googlecode/attention/sms/pdu/SRQ.java $
 * 
 * Copyright (c) 2007, Stein Gunnar Bakkeby
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Stein Gunnar Bakkeby nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.attention.sms.pdu;

import static com.googlecode.attention.util.bit.ByteBitValues.*;

/**
 * TP-Status-Report-Qualifier (TP-SRQ).
 * <BR>
 * The TP-Status-Report-Qualifier is a 1 bit field located within
 * bit 5 of the first octet of SMS-STATUS-REPORT and has the
 * following values:
 * <BR>
 * <BR>Bit no. 5:
 * <BR>
 * <TABLE>
 * <TR><TD>0</TD><TD>The SMS-STATUS-REPORT is the result of a SMS-SUBMIT.</TD></TR>
 * <TR><TD>1</TD><TD>The SMS-STATUS-REPORT is the result of an SMS-COMMAND e.g. an Enquiry.</TD></TR>
 * </TABLE>
 * 
 * @author Stein Gunnar Bakkeby
 */
public enum SRQ {

  /** The SMS-STATUS-REPORT is the result of a SMS-SUBMIT. */
  SMS_SUBMIT(0),
  /** The SMS-STATUS-REPORT is the result of an SMS-COMMAND e.g. an Enquiry. */
  SMS_COMMAND(B5);
  
  /** The binary value of the SRQ. */
  public int value;

  private SRQ(int value) {
    this.value = value;
  }
  
  /**
   * This will return the correct SRQ enum based on the integer passed in.
   * 
   * @param value Can be bit 7 of the first octet, or the first octet itself
   * @return The corresponding SRQ enum
   */
  public static SRQ parse(int value) {
    value &= B5;
    switch (value) {
    case B5:
      return SMS_COMMAND;
    case 0:
    default:
      return SMS_SUBMIT;
    }
  }
}